﻿//-----------------------------------------------------------------------
// <copyright file="HtmlHelperImageExtensions.cs" company="OOHM PROCESSAMENTO DE DADOS LTDA.">
//     Microsoft Public License (MS-PL) This license governs use of the accompanying
//     software. If you use the software, you accept this license. If you do not
//     accept the license, do not use the software. 1. Definitions The terms "reproduce,"
//     "reproduction," "derivative works," and "distribution" have the same meaning
//     here as under U.S. copyright law. A "contribution" is the original software,
//     or any additions or changes to the software. A "contributor" is any person
//     that distributes its contribution under this license. "Licensed patents"
//     are a contributor's patent claims that read directly on its contribution.
//     2. Grant of Rights (A) Copyright Grant- Subject to the terms of this license,
//     including the license conditions and limitations in section 3, each contributor
//     grants you a non-exclusive, worldwide, royalty-free copyright license to
//     reproduce its contribution, prepare derivative works of its contribution,
//     and distribute its contribution or any derivative works that you create.
//     (B) Patent Grant- Subject to the terms of this license, including the license
//     conditions and limitations in section 3, each contributor grants you a non-exclusive,
//     worldwide, royalty-free license under its licensed patents to make, have
//     made, use, sell, offer for sale, import, and/or otherwise dispose of its
//     contribution in the software or derivative works of the contribution in
//     the software. 3. Conditions and Limitations (A) No Trademark License- This
//     license does not grant you rights to use any contributors' name, logo, or
//     trademarks. (B) If you bring a patent claim against any contributor over
//     patents that you claim are infringed by the software, your patent license
//     from such contributor to the software ends automatically. (C) If you distribute
//     any portion of the software, you must retain all copyright, patent, trademark,
//     and attribution notices that are present in the software. (D) If you distribute
//     any portion of the software in source code form, you may do so only under
//     this license by including a complete copy of this license with your distribution.
//     If you distribute any portion of the software in compiled or object code
//     form, you may only do so under a license that complies with this license.
//     (E) The software is licensed "as-is." You bear the risk of using it. The
//     contributors give no express warranties, guarantees or conditions. You may
//     have additional consumer rights under your local laws which this license
//     cannot change. To the extent permitted under your local laws, the contributors
//     exclude the implied warranties of merchantability, fitness for a particular
// </copyright>
//-----------------------------------------------------------------------
namespace AbstractSaaSTemplate.Web.UI.Helpers{    using System;
    using System.Globalization;
    using System.IO;
    using System.Web;
    using System.Web.Mvc;
    using AbstractSaaSTemplate.Application.Customization;
    using AbstractSaaSTemplate.Application.Localization;

    /// <summary>
    /// Provides extensibility to the HtmlHelper, related to images.
    /// </summary>
    public static class HtmlHelperImageExtensions
    {
        /// <summary>
        /// Renders a default loading icon for the application.
        /// </summary>
        /// <param name="helper">The helper which will be extended</param>
        /// <param name="id">The id for the image tag.</param>
        /// <returns>Returns an expression MvcHtmlString containing the loading icon image tag.</returns>
        public static MvcHtmlString LoadingIcon(this HtmlHelper helper, string id)
        {
            return Image(
                helper,
                id,
                ImageType.Icon,
                "loading.gif",
                "loading",
                Messages.PleaseWait);
        }

        /// <summary>
        /// Renders an image to the view.
        /// </summary>
        /// <param name="helper">The helper which will be extended</param>
        /// <param name="type">The type of the image</param>
        /// <param name="fileName">The filename of the image</param>
        /// <param name="className">The class name (or names)</param>
        /// <param name="alternativeText">The alternative text for the image.</param>
        /// <returns>Returns an expression MvcHtmlString containing the image tag.</returns>
        public static MvcHtmlString Image(
            this HtmlHelper helper,
            ImageType type,
            string fileName,
            string className,
            string alternativeText)
        {
            return Image(
                helper,
                null,
                type,
                fileName,
                className,
                alternativeText);
        }
        
        /// <summary>
        /// Renders an image to the view.
        /// </summary>
        /// <param name="helper">The helper which will be extended</param>
        /// <param name="id">The id for the image tag.</param>
        /// <param name="type">The type of the image</param>
        /// <param name="fileName">The filename of the image</param>
        /// <param name="alternativeText">The alternative text for the image.</param>
        /// <returns>Returns an expression MvcHtmlString containing the image tag.</returns>
        public static MvcHtmlString Image(
            this HtmlHelper helper,
            string id,
            ImageType type,
            string fileName,
            string alternativeText)                                            
        {                                                                                                                       
            return helper.Image(
                id,
                type,
                fileName,
                null,
                alternativeText);
        }
        
        /// <summary>
        /// Renders an image to the view.
        /// </summary>
        /// <param name="helper">The helper which will be extended</param>
        /// <param name="id">The id for the image tag.</param>
        /// <param name="type">The type of the image</param>
        /// <param name="fileName">The filename of the image</param>
        /// <param name="className">The class name (or names)</param>
        /// <param name="alternativeText">The alternative text for the image.</param>
        /// <returns>Returns an expression MvcHtmlString containing the image tag.</returns>
        public static MvcHtmlString Image(
            this HtmlHelper helper,
            string id,
            ImageType type,
            string fileName,
            string className,
            string alternativeText)
        {
            // validates the inbound parameters
            if (helper == null)
            {
                throw new ArgumentNullException("helper");
            }

            if (string.IsNullOrWhiteSpace(fileName))
            {
                throw new ArgumentNullException("fileName");
            }

            if (!fileName.Contains("."))
            {
                throw new ArgumentException(string.Format(
                    CultureInfo.CurrentUICulture,
                    Messages.TheValueXIsInvalidForTheParameterY,
                    fileName,
                    "fileName"));
            }

            // retrieves the name of the file from the
            // path, in case somebody has 
            fileName = Path.GetFileName(fileName);

            // there may be a custom theme defined
            var themeName = helper.GetThemeFromActiveTenant().ToString();

            // build the directory and the image path
            var fullPath = VirtualPathUtility.ToAbsolute(string.Concat(
                "~/Content/Themes/",
                themeName,
                "/Images/",
                type,
                "/",
                fileName));
            
            // generate the tag with the paramters
            var img = new TagBuilder("img");
            img.MergeAttribute("src", fullPath);
            img.MergeAttribute("alt", alternativeText);
            img.MergeAttribute("title", alternativeText);

            // the optional parameters like id
            // or class and are only added.
            if (!string.IsNullOrWhiteSpace(id))
            {
                img.MergeAttribute("id", id);
            }

            if (!string.IsNullOrWhiteSpace(className))
            {
                img.MergeAttribute("class", className);
            }

            // generate the MvcHtmlString object.
            var html = img.ToString(TagRenderMode.SelfClosing);
            return MvcHtmlString.Create(html);
        }
    }
}


